/*-
 *******************************************************************************
 * Copyright (c) 2011, 2016 Diamond Light Source Ltd.
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v1.0
 * which accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/epl-v10.html
 *
 * Contributors:
 *    Matthew Gerring - initial API and implementation and/or initial documentation
 *******************************************************************************/
package org.eclipse.scanning.api.device.models;

/**
 * An enumeration of detector modes. This determines whether the detector can take
 * part in a GDA scan or a hardare (i.e. malcolm) scan. A detector may support
 * one or both of these modes.
 *
 * @author Matthew Dickie
 */
public enum ScanMode {

	/**
	 * A scan that is run entirely in software by GDA
	 */
	SOFTWARE,

	/**
	 * A scan that is at least partially (an inner-scan) performed
	 * by hardware (i.e. malcolm) with GDA only performing an outer scan.
	 */
	HARDWARE;

	/**
	 * Returns a user friendly name, e.g. SOFTWARE -> "Software"
	 * @see java.lang.Enum#toString()
	 */
	@Override
	public String toString() {
		return name().charAt(0) + name().substring(1).toLowerCase();
	}

}
